FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.7.16  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.resp-net#current (125 ms)

Package hl7.fhir.us.resp-net
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/resp-net/https://build.fhir.org/ig/HL7/fhir-resp-net-ig/CapabilityStatement-resp-net-data-source.html
Url http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source
Version 1.0.0
Status draft
Date 2020-12-06
Name RespNetEHRCapabilityStatement
Title RESP-NET EHR Capability Statement
Experimental False
Realm us
Authority hl7
Description This profile defines the expected capabilities of the ''EHR'' actor when conforming to the RESP-NET Content Implementation Guide. This role is responsible for allowing creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Data Source (e.g EHR)

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the Data Source (e.g EHR) actor to support the RESP-NET use cases. Data Sources can be implemented and deployed with HDEA capability bundled together also identified as Data Source with HDEA functionality. Data Sources may be implemented with an external HDEA identified as Data Source with External HDEA. The conformance requirements for these different DataSources with and without HDEA functionality is different and outlined below.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

Data Source with HDEA functionality bundled together

The primary focus of the Data Source actor in this case is to create the RESPnet report and send it to the PHA.

Data Sources (with inbuilt HDEA functionality) SHALL meet the general security requirements documented in FHIR Security guidance.

Data Sources (with inbuilt HDEA functionality) SHALL be capable of generating the RESP-NET reporting Bundle in response to a encounter-close named-event

Data Sources (with inbuilt HDEA functionality) SHALL be capable of submitting the RESP-NET reporting Bundle to the Public Health Agency(PHA) using $process-message operation

Data Sources (with inbuilt HDEA functionality) SHALL use SMART on FHIR Backend Services to authenticate and authorize with the PHA to submit the bundle to the $process-message operation

Data Source supporting External HDEA application

The primary focus of the Data Source actor is to allow the creation, modification and deletion of Subscriptions, notify subscribers based on subscriptions and support US Core APIs.

The rest of the requirements identified below in this capability statement only apply Data Sources supporting external HDEA Applications

Security Requirements:

Data Sources supporting external HDEA applications must meet the general security requirements documented in FHIR Security guidance.

In addition the Data Source supporting external HDEA applications (e.g EHR) needs to meet the security requirements as outlined in the Formal Specification - SMART on FHIR Backend Services Requirements.

US Core Support

The Data Source supporting external HDEA (e.g EHR) SHALL implement the US Core Server capability statement as foundational FHIR APIs needed by the RESP-NET Content IG.


Resource summary for Data Sources supporting external HDEA applications



Subscription (Includes Subscriptions for encounter-close Subscription Topic)

Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html

Interactions

Name Description
  read

Allows retrieval of a specific Subscription instance.

  create

Allows creation of Subscription instances

  update

Allows Update of Subscription instances

  delete

Allows deletion of Subscription instances



Bundle (Notification Bundle for Subscriptions)

Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html)

Interactions

Name Description
  create

Allows creation of Notification Bundles for Subscriptions



Parameters (Parameters Profile to retrieve Subscription Status)

Profile: "subscriptionstatus profile from Subscription-backport Implementation Guide"

Interactions

Name Description
  read

Allows clients to request Subscription Status for Subscriptions



US Core APIs

Profile: All US Core profiles

Interactions

Name Description
  search

Allows searching of specific US Core resource profile instances.

  read

Allows retrieval of specific US Core resource profile instances



MedicationAdministration

Profile: "us-ph-medicationadministration from Public Health Library"

Interactions

Name Description
  search

Allows searching of specific MedicationAdministration resource profile instances.

  read

Allows retrieval of specific MedicationAdministration resource profile instances




Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "resp-net-data-source",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Data Source (e.g EHR)</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source</p>\n <p>Published by: <b>HL7 International - Public Health Work Group</b>\n </p>\n <p>This profile defines the expected capabilities of the <i>Data Source (e.g EHR) </i> actor to support the RESP-NET use cases. \n Data Sources can be implemented and deployed with HDEA capability bundled together also identified as Data Source with HDEA functionality.\n Data Sources may be implemented with an external HDEA identified as Data Source with External HDEA.\n The conformance requirements for these different DataSources with and without HDEA functionality is different and outlined below.\n </p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table>\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST behavior</h2>\n <h3>Data Source with HDEA functionality bundled together</h3>\n <p> The primary focus of the Data Source actor in this case is to create the RESPnet report and send it to the PHA.\n </p>\n \n <p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> be capable of generating the RESP-NET reporting Bundle in response to a encounter-close named-event</p>\n <p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> be capable of submitting the RESP-NET reporting Bundle to the Public Health Agency(PHA) using $process-message operation</p>\n <p>Data Sources (with inbuilt HDEA functionality) <b>SHALL</b> use SMART on FHIR Backend Services to authenticate and authorize with the PHA to submit the bundle to the $process-message operation</p>\n \n \n <h3>Data Source supporting External HDEA application</h3>\n <p>The primary focus of the Data Source actor is to allow the creation, modification and deletion of Subscriptions, notify subscribers based on subscriptions and support US Core APIs.</p>\n <p>The rest of the requirements identified below in this capability statement only apply Data Sources supporting external HDEA Applications</p>\n <p>\n <b>Security Requirements:</b>\n </p>\n <p>Data Sources supporting external HDEA applications must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>In addition the Data Source supporting external HDEA applications (e.g EHR) needs to meet the security requirements as outlined in the <a href=\"spec.html#smart-on-fhir-backend-services-requirements\">Formal Specification - SMART on FHIR Backend Services Requirements.</a></p>\n\n <h3>US Core Support</h3>\n\n <p>\n The Data Source supporting external HDEA (e.g EHR) <b>SHALL</b> implement the \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html\">US Core Server capability statement</a> as foundational FHIR APIs needed by the RESP-NET Content IG.\n </p>\n <br/>\n\n <h3>Resource summary for Data Sources supporting external HDEA applications</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n <th>Operations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html\">Backported Subscription</a></th>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-read\" title=\"Allows retrieval of a specific Subscription Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-create\" title=\"Allows creation of a specific Subscription Resource instance\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-update\" title=\"Allows update of a specific Subscription Resource instance\">SHALL</a>\n </td>\n\t\t\t <td>\n <a href=\"#Subscription-delete\" title=\"Allows deletion of a specific Subscription Resource instance\">SHALL</a>\n </td>\n <td>\n <a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscriptiontopic-list.html\">$topic-list</a>\n <a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/OperationDefinition-backport-subscription-status.html\">$status</a>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-medmorph/StructureDefinition-medmorph-encounter-end-subscription.html\">Encounter End Subscription Topic</a></th>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-read\" title=\"Allows retrieval of a Encounter End Subscription instance.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-create\" title=\"Allows creation of a Subscription Resource instance for Encounter End event notification\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-update\" title=\"Allows update of a Subscription Resource instance for Encounter End event notification\">SHALL</a>\n </td>\n <td>\n <a href=\"#Subscription-delete\" title=\"Allows deletion of a Subscription Resource instance for Encounter End event notification\">SHALL</a>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html\">Backport Subscription Notification Bundle</a></th>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Notification-Bundle-create\" title=\"Allows creation of a Subscription Notification Bundle for Encounter close event\">SHALL</a>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscriptionstatus.html\">Backport Subscription Status</a></th>\n <td>\n </td>\n <td>\n <a href=\"#Subscription-Status-read\" title=\"Allows retrieval of a Subscription Status for a specific Subscription\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th>US Core APIs</th>\n <td>\n <a href=\"#USCore-search-type\" title=\"Allows search of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n <a href=\"#USCore-read\" title=\"Allows retrieval of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n\t\t\t <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th><a href=\"http://hl7.org/fhir/R4/medicationadministration.html\">MedicationAdministration</a></th>\n <td>\n <a href=\"#MedAdm-search\" title=\"Allows search of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n <a href=\"#MedAdm-read\" title=\"Allows retrieval of a specific US Core Resource instances.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/subscription.html\">Subscription (Includes Subscriptions for encounter-close Subscription Topic)</a>\n </h3>\n <p>Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription.html\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Subscription-read\">�</a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of a specific Subscription instance.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Subscription-create\">�</a>\n <span>create</span>\n </th>\n <td>\n <p>Allows creation of Subscription instances</p>\n </td>\n </tr> \n <tr>\n <th>\n <a name=\"Subscription-update\">�</a>\n <span>update</span>\n </th>\n <td>\n <p>Allows Update of Subscription instances</p>\n </td>\n </tr> \n <tr>\n <th>\n <a name=\"Subscription-delete\">�</a>\n <span>delete</span>\n </th>\n <td>\n <p>Allows deletion of Subscription instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n <h3>\n <a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle (Notification Bundle for Subscriptions)</a>\n </h3>\n <p>Profile: http://build.fhir.org/ig/HL7/fhir-subscription-backport-ig/StructureDefinition-backport-subscription-notification.html)\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Notification-Bundle-create\">�</a>\n <span>create</span>\n </th>\n <td>\n <p>Allows creation of Notification Bundles for Subscriptions </p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/parameters.html\">Parameters (Parameters Profile to retrieve Subscription Status)</a>\n </h3>\n <p>Profile: &quot;subscriptionstatus profile from Subscription-backport Implementation Guide&quot;\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Subscription-Status-read\">�</a>\n <span>read</span>\n </th>\n <td>\n <p>Allows clients to request Subscription Status for Subscriptions </p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/us/core\">US Core APIs</a>\n </h3>\n <p>Profile: All US Core profiles\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"USCore-search-type\">�</a>\n <span>search</span>\n </th>\n <td>\n <p>Allows searching of specific US Core resource profile instances.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"USCore-read\">�</a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific US Core resource profile instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n <h3>\n <a href=\"http://hl7.org/fhir/medicationadministration.html\">MedicationAdministration</a>\n </h3>\n <p>Profile: &quot;us-ph-medicationadministration from Public Health Library&quot;\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"MedAdm-search\">�</a>\n <span>search</span>\n </th>\n <td>\n <p>Allows searching of specific MedicationAdministration resource profile instances.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"MedAdm-read\">�</a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific MedicationAdministration resource profile instances</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n </div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "pher"
    }
  ],
  "url" : "http://hl7.org/fhir/us/resp-net/CapabilityStatement/resp-net-data-source",
  "version" : "1.0.0",
  "name" : "RespNetEHRCapabilityStatement",
  "title" : "RESP-NET EHR Capability Statement",
  "status" : "draft",
  "date" : "2020-12-06",
  "publisher" : "HL7 International / Public Health",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of the ''EHR'' actor when conforming to the RESP-NET Content Implementation Guide. This role is responsible for allowing creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The focus of the EHR is to allow creation, modification and deletion of Subscriptions and allows searching and retrieval of resources using US Core APIs. ",
      "security" : {
        "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "resource" : [
        {
          "type" : "Subscription",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Subscription instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "create",
              "documentation" : "Allows creation of a Subscription resource instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "update",
              "documentation" : "Allows update of a Subscription resource instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "delete",
              "documentation" : "Allows deletion of a Subscription resource instance."
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.